Home       Trees       Index       Help   

"Lemon"

Package lemon :: Package external :: Package epydoc :: Package markup :: Module restructuredtext :: Class _DocumentPseudoWriter
[show private | hide private]
[frames | no frames]

Class _DocumentPseudoWriter

 SettingsSpec --+        
                |        
TransformSpec --+        
                |        
        Component --+    
                    |    
               Writer --+
                        |
                       _DocumentPseudoWriter

A pseudo-writer for the docutils framework, that can be used to access the document itself. The output of _DocumentPseudoWriter is just an empty string; but after it has been used, the most recently processed document is available as the instance variable document
Method Summary
  __init__(self)
Initialize the Writer instance.
  translate(self)
Override to do final document tree translation.
    Inherited from Writer
  write(self, document, destination)
    Inherited from Component
  supports(self, format)
Is format supported by this component?

Instance Variable Summary
docutils.nodes.document document: The most recently processed document.

Class Variable Summary
    Inherited from Writer
str component_type = 'writer'
NoneType destination = None                                                                  
NoneType language = None                                                                  
    Inherited from Component
tuple supported = ()
    Inherited from SettingsSpec
tuple relative_path_settings = ()
NoneType settings_default_overrides = None                                                                  
NoneType settings_defaults = None                                                                  
tuple settings_spec = ()
    Inherited from TransformSpec
tuple default_transforms = ()

Method Details

__init__(self)
(Constructor)

Initialize the Writer instance.
Overrides:
docutils.writers.Writer.__init__ (inherited documentation)

translate(self)

Override to do final document tree translation.

This is usually done with a docutils.nodes.NodeVisitor subclass, in combination with a call to docutils.nodes.Node.walk() or docutils.nodes.Node.walkabout(). The NodeVisitor subclass must support all standard elements (listed in docutils.nodes.node_class_names) and possibly non-standard elements used by the current Reader as well.

Overrides:
docutils.writers.Writer.translate (inherited documentation)

Instance Variable Details

document

The most recently processed document.
Type:
docutils.nodes.document

   Home       Trees       Index       Help   

"Lemon"

Generated by Epydoc 2.0 on Mon Nov 10 15:07:40 2003 http://epydoc.sf.net